<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="lib.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python documentation Index' />
<link rel="first" href="lib.html" title='Python library Reference' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="module-curses.html" />
<link rel="prev" href="module-logging.html" />
<link rel="parent" href="allos.html" />
<link rel="next" href="module-curses.html" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name='aesop' content='information' />
<title>14.6 getpass -- Portable password input</title>
</head>
<body>
<div class="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="14.5.10.2 configuration file format"
  href="logging-config-fileformat.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="14. generic Operating System"
  href="allos.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="14.7 curses  "
  href="module-curses.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></a></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></a></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="logging-config-fileformat.html">14.5.10.2 Configuration file format</a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="allos.html">14. Generic Operating System</a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-curses.html">14.7 curses  </a>
</div>
<hr /></div>
</div>
<!--End of Navigation Panel-->

<h1><a name="SECTION0016600000000000000000">
14.6 <tt class="module">getpass</tt>
         -- Portable password input</a>
</h1>

<p>
<a name="module-getpass"></a>

<p>
The <tt class="module">getpass</tt> module provides two functions:

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-2967' xml:id='l2h-2967' class="function">getpass</tt></b>(</nobr></td>
  <td><var></var><big>[</big><var>prompt</var><big>[</big><var>, stream</var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
  Prompt the user for a password without echoing.  The user is
  prompted using the string <var>prompt</var>, which defaults to
  <code>'Password: '</code>. On <span class="Unix">Unix</span>, the prompt is written to the
  file-like object <var>stream</var>, which defaults to
  <code>sys.stdout</code> (this argument is ignored on Windows).

<p>
Availability: Macintosh, <span class="Unix">Unix</span>, Windows.
  
<span class="versionnote">Changed in version 2.5:
The <var>stream</var> parameter was added.</span>

</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-2968' xml:id='l2h-2968' class="function">getuser</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
  Return the ``login name'' of the user.
  Availability: <span class="Unix">Unix</span>, Windows.

<p>
This function checks the environment variables <a class="envvar" id='l2h-2969' xml:id='l2h-2969'>LOGNAME</a>,
  <a class="envvar" id='l2h-2970' xml:id='l2h-2970'>USER</a>, <a class="envvar" id='l2h-2971' xml:id='l2h-2971'>LNAME</a> and <a class="envvar" id='l2h-2972' xml:id='l2h-2972'>USERNAME</a>, in order, and
  returns the value of the first one which is set to a non-empty
  string.  If none are set, the login name from the password database
  is returned on systems which support the <tt class="module"><a href="module-pwd.html">pwd</a></tt> module,
  otherwise, an exception is raised.
</dl>

<div class="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="14.5.10.2 configuration file format"
  href="logging-config-fileformat.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="14. generic Operating System"
  href="allos.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="14.7 curses  "
  href="module-curses.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></a></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></a></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="logging-config-fileformat.html">14.5.10.2 Configuration file format</a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="allos.html">14. Generic Operating System</a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-curses.html">14.7 curses  </a>
</div>
</div>
<hr />
<span class="release-info">Release 2.5.1, documentation updated on 18th April, 2007.</span>
</div>
<!--End of Navigation Panel-->
<address>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</address>
</body>
</html>
